

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Literal Text [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Code Template,Code Template Syntax, Literal Text">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Literal Text</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="codetemplatesyntax.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="macros.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">All text within a given template that is not part of a macro or a variable definition/reference, is considered literal text. With the exception of blank lines, which are ignored, literal text is directly substituted from the template into the generated code.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Consider the following excerpt from the java Class Declaration template:</span></p>
<p class="p_Code"><span class="f_Code">%PI=&quot; &quot;%</span></p>
<p class="p_Code"><span class="f_Code">%CONVERT_SCOPE(classScope)%</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_Code"><span class="f_Code">%classStereotype==&quot;static&quot; ? &quot;static&quot;: &quot;&quot;%</span></p>
<p class="p_Code"><span class="f_Code">%classStereotype==&quot;final&quot; ? &quot;final&quot;: &quot;&quot;%</span></p>
<p class="p_Code"><span class="f_Code">%classStereotype==&quot;static final&quot; ? &quot;static final&quot;: &quot;&quot;%</span></p>
<p class="p_Code"><span class="f_Code">%classAbstract==&quot;T&quot; ? &quot;abstract&quot;: &quot;&quot;%</span></p>
<p class="p_Code"><span class="f_Code">%PI=&quot;&quot;%</span></p>
<p class="p_Code"><span class="f_Code">class %className%$bases</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_BodyText"><span class="f_BodyText">On the final line, the word </span><span class="f_BodyText" style="font-style: italic;">class</span><span class="f_BodyText">, including the subsequent space, would be treated as literal text and thus reproduced in the output. The blank line following the </span><span class="f_BodyText" style="font-style: italic;">CONVERT_SCOPE</span><span class="f_BodyText"> macro, however, would have no effect on the output.</span></p>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_BodyText" style="font-style: italic;">%, $</span><span class="f_BodyText"> and </span><span class="f_BodyText" style="font-style: italic;">&quot;</span><span class="f_BodyText"> characters have special meaning in the template syntax and cannot always be used as literal text. If these characters must be generated from within the templates, they can be safely reproduced using the following direct substitution macros:</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="68" bgcolor="#e3e6ed" style="width:68px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Macro</span></p>
</td>
<td valign="top" width="198" bgcolor="#e3e6ed" style="width:198px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Description</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="68" style="width:68px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">%dl%</span></p>
</td>
<td valign="top" width="198" style="width:198px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Produces a literal $ character.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="68" style="width:68px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">%pc%</span></p>
</td>
<td valign="top" width="198" style="width:198px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Produces a literal % character.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="68" style="width:68px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">%qt%</span></p>
</td>
<td valign="top" width="198" style="width:198px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Produces a literal &quot; character.</span></p>
</td>
</tr>
</table>
</div>




            </div>
          </div>
        </div>



</div>


</body>
</html>
